home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 October: Mac OS SDK / Dev.CD Oct 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / PInterfaces / DatabaseAccess.p < prev    next >
Encoding:
Text File  |  1997-08-12  |  12.4 KB  |  337 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        DatabaseAccess.p
  3.  
  4.      Contains:    Database Access Manager Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0.1
  8.  
  9.      Copyright:    © 1989-1993, 1995-1997 by Apple Computer, Inc., all rights reserved
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT DatabaseAccess;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __DATABASEACCESS__}
  28. {$SETC __DATABASEACCESS__ := 1}
  29.  
  30. {$I+}
  31. {$SETC DatabaseAccessIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __RESOURCES__}
  35. {$I Resources.p}
  36. {$ENDC}
  37.  
  38.  
  39. {$PUSH}
  40. {$ALIGN MAC68K}
  41. {$LibExport+}
  42.  
  43. { data type codes }
  44.  
  45. CONST
  46.     typeNone                    = 'none';
  47.     typeDate                    = 'date';
  48.     typeTime                    = 'time';
  49.     typeTimeStamp                = 'tims';
  50.     typeDecimal                    = 'deci';
  51.     typeMoney                    = 'mone';
  52.     typeVChar                    = 'vcha';
  53.     typeVBin                    = 'vbin';
  54.     typeLChar                    = 'lcha';
  55.     typeLBin                    = 'lbin';
  56.     typeDiscard                    = 'disc';                        {  "dummy" types for DBResultsToText  }
  57.     typeUnknown                    = 'unkn';
  58.     typeColBreak                = 'colb';
  59.     typeRowBreak                = 'rowb';                        {  pass this in to DBGetItem for any data type  }
  60.     typeAnyType                    = 0;
  61.  
  62. { infinite timeout value for DBGetItem }
  63.                                                                 {  messages for status functions for DBStartQuery  }
  64.     kDBUpdateWind                = 0;
  65.     kDBAboutToInit                = 1;
  66.     kDBInitComplete                = 2;
  67.     kDBSendComplete                = 3;
  68.     kDBExecComplete                = 4;
  69.     kDBStartQueryComplete        = 5;
  70.  
  71.                                                                 {  messages for status functions for DBGetQueryResults  }
  72.     kDBGetItemComplete            = 6;
  73.     kDBGetQueryResultsComplete    = 7;
  74.     kDBWaitForever                = -1;
  75.  
  76.                                                                 {   flags for DBGetItem   }
  77.     kDBLastColFlag                = $0001;
  78.     kDBNullFlag                    = $0004;
  79.  
  80.  
  81. TYPE
  82.     DBType                                = OSType;
  83.     DBAsyncParamBlockRecPtr = ^DBAsyncParamBlockRec;
  84.     DBAsyncParmBlkPtr                    = ^DBAsyncParamBlockRec;
  85.     DBCompletionProcPtr = Register68kProcPtr;  { PROCEDURE DBCompletion(pb: DBAsyncParmBlkPtr); }
  86.  
  87.     DBCompletionUPP = UniversalProcPtr;
  88. { structure for asynchronous parameter block }
  89.     DBAsyncParamBlockRec = RECORD
  90.         completionProc:            DBCompletionUPP;                        {  pointer to completion routine  }
  91.         result:                    OSErr;                                    {  result of call  }
  92.         userRef:                LONGINT;                                {  for application's use  }
  93.         ddevRef:                LONGINT;                                {  for ddev's use  }
  94.         reserved:                LONGINT;                                {  for internal use  }
  95.     END;
  96.  
  97. { structure for resource list in QueryRecord }
  98.     ResListElemPtr = ^ResListElem;
  99.     ResListElem = RECORD
  100.         theType:                ResType;                                {  resource type  }
  101.         id:                        INTEGER;                                {  resource id  }
  102.     END;
  103.  
  104.     ResListPtr                            = ^ResListElem;
  105.     ResListHandle                        = ^ResListPtr;
  106. { structure for query list in QueryRecord }
  107.     QueryArray                            = ARRAY [0..255] OF Handle;
  108.     QueryListPtr                        = ^QueryArray;
  109.     QueryListHandle                        = ^QueryListPtr;
  110.     QueryRecordPtr = ^QueryRecord;
  111.     QueryRecord = RECORD
  112.         version:                INTEGER;                                {  version  }
  113.         id:                        INTEGER;                                {  id of 'qrsc' this came from  }
  114.         queryProc:                Handle;                                    {  handle to query def proc  }
  115.         ddevName:                Str63;                                    {  ddev name  }
  116.         host:                    Str255;                                    {  host name  }
  117.         user:                    Str255;                                    {  user name  }
  118.         password:                Str255;                                    {  password  }
  119.         connStr:                Str255;                                    {  connection string  }
  120.         currQuery:                INTEGER;                                {  index of current query  }
  121.         numQueries:                INTEGER;                                {  number of queries in list  }
  122.         queryList:                QueryListHandle;                        {  handle to array of handles to text  }
  123.         numRes:                    INTEGER;                                {  number of resources in list  }
  124.         resList:                ResListHandle;                            {  handle to array of resource list elements  }
  125.         dataHandle:                Handle;                                    {  for use by query def proc  }
  126.         refCon:                    LONGINT;                                {  for use by application  }
  127.     END;
  128.  
  129.     QueryPtr                            = ^QueryRecord;
  130.     QueryHandle                            = ^QueryPtr;
  131. { structure of column types array in ResultsRecord }
  132.     ColTypesArray                        = ARRAY [0..255] OF DBType;
  133.     ColTypesPtr                            = ^ColTypesArray;
  134.     ColTypesHandle                        = ^ColTypesPtr;
  135. { structure for column info in ResultsRecord }
  136.     DBColInfoRecordPtr = ^DBColInfoRecord;
  137.     DBColInfoRecord = RECORD
  138.         len:                    INTEGER;
  139.         places:                    INTEGER;
  140.         flags:                    INTEGER;
  141.     END;
  142.  
  143.     ColInfoArray                        = ARRAY [0..255] OF DBColInfoRecord;
  144.     ColInfoPtr                            = ^ColInfoArray;
  145.     ColInfoHandle                        = ^ColInfoPtr;
  146. { structure of results returned by DBGetResults }
  147.     ResultsRecordPtr = ^ResultsRecord;
  148.     ResultsRecord = RECORD
  149.         numRows:                INTEGER;                                {  number of rows in result  }
  150.         numCols:                INTEGER;                                {  number of columns per row  }
  151.         colTypes:                ColTypesHandle;                            {  data type array  }
  152.         colData:                Handle;                                    {  actual results  }
  153.         colInfo:                ColInfoHandle;                            {  DBColInfoRecord array  }
  154.     END;
  155.  
  156.  
  157. CONST
  158.                                                                 {  messages sent to a 'ddev' }
  159.     kDBInit                        = 0;
  160.     kDBEnd                        = 1;
  161.     kDBGetConnInfo                = 2;
  162.     kDBGetSessionNum            = 3;
  163.     kDBSend                        = 4;
  164.     kDBSendItem                    = 5;
  165.     kDBExec                        = 6;
  166.     kDBState                    = 7;
  167.     kDBGetErr                    = 8;
  168.     kDBBreak                    = 9;
  169.     kDBGetItem                    = 10;
  170.     kDBUngetItem                = 11;
  171.     kDBKill                        = 12;
  172.     kDBOpen                        = 100;
  173.     kDBClose                    = 101;
  174.     kDBIdle                        = 102;
  175.  
  176.  
  177. TYPE
  178.     DBQueryDefProcPtr = ProcPtr;  { FUNCTION DBQueryDef(VAR sessID: LONGINT; query: QueryHandle): OSErr; }
  179.  
  180.     DBStatusProcPtr = ProcPtr;  { FUNCTION DBStatus(message: INTEGER; result: OSErr; dataLen: INTEGER; dataPlaces: INTEGER; dataFlags: INTEGER; dataType: DBType; dataPtr: Ptr): BOOLEAN; }
  181.  
  182.     DBResultHandlerProcPtr = ProcPtr;  { FUNCTION DBResultHandler(dataType: DBType; theLen: INTEGER; thePlaces: INTEGER; theFlags: INTEGER; theData: Ptr; theText: Handle): OSErr; }
  183.  
  184.     DBQueryDefUPP = UniversalProcPtr;
  185.     DBStatusUPP = UniversalProcPtr;
  186.     DBResultHandlerUPP = UniversalProcPtr;
  187.  
  188. CONST
  189.     uppDBCompletionProcInfo = $0000B802;
  190.     uppDBQueryDefProcInfo = $000003E0;
  191.     uppDBStatusProcInfo = $000FAA90;
  192.     uppDBResultHandlerProcInfo = $0003EAE0;
  193.  
  194. FUNCTION NewDBCompletionProc(userRoutine: DBCompletionProcPtr): DBCompletionUPP;
  195.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  196.     INLINE $2E9F;
  197.     {$ENDC}
  198.  
  199. FUNCTION NewDBQueryDefProc(userRoutine: DBQueryDefProcPtr): DBQueryDefUPP;
  200.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  201.     INLINE $2E9F;
  202.     {$ENDC}
  203.  
  204. FUNCTION NewDBStatusProc(userRoutine: DBStatusProcPtr): DBStatusUPP;
  205.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  206.     INLINE $2E9F;
  207.     {$ENDC}
  208.  
  209. FUNCTION NewDBResultHandlerProc(userRoutine: DBResultHandlerProcPtr): DBResultHandlerUPP;
  210.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  211.     INLINE $2E9F;
  212.     {$ENDC}
  213.  
  214. PROCEDURE CallDBCompletionProc(pb: DBAsyncParmBlkPtr; userRoutine: DBCompletionUPP);
  215.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  216.     {To be implemented:  Glue to move parameters into registers.}
  217.     {$ENDC}
  218.  
  219. FUNCTION CallDBQueryDefProc(VAR sessID: LONGINT; query: QueryHandle; userRoutine: DBQueryDefUPP): OSErr;
  220.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  221.     INLINE $205F, $4E90;
  222.     {$ENDC}
  223.  
  224. FUNCTION CallDBStatusProc(message: INTEGER; result: OSErr; dataLen: INTEGER; dataPlaces: INTEGER; dataFlags: INTEGER; dataType: DBType; dataPtr: Ptr; userRoutine: DBStatusUPP): BOOLEAN;
  225.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  226.     INLINE $205F, $4E90;
  227.     {$ENDC}
  228.  
  229. FUNCTION CallDBResultHandlerProc(dataType: DBType; theLen: INTEGER; thePlaces: INTEGER; theFlags: INTEGER; theData: Ptr; theText: Handle; userRoutine: DBResultHandlerUPP): OSErr;
  230.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  231.     INLINE $205F, $4E90;
  232.     {$ENDC}
  233. FUNCTION InitDBPack: OSErr;
  234.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  235.     INLINE $3F3C, $0004, $303C, $0100, $A82F;
  236.     {$ENDC}
  237. FUNCTION DBInit(VAR sessID: LONGINT; ddevName: ConstStr63Param; host: ConstStr255Param; user: ConstStr255Param; passwd: ConstStr255Param; connStr: ConstStr255Param; asyncPB: DBAsyncParmBlkPtr): OSErr;
  238.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  239.     INLINE $303C, $0E02, $A82F;
  240.     {$ENDC}
  241. FUNCTION DBEnd(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  242.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  243.     INLINE $303C, $0403, $A82F;
  244.     {$ENDC}
  245. FUNCTION DBGetConnInfo(sessID: LONGINT; sessNum: INTEGER; VAR returnedID: LONGINT; VAR version: LONGINT; VAR ddevName: Str63; VAR host: Str255; VAR user: Str255; VAR network: Str255; VAR connStr: Str255; VAR start: LONGINT; VAR state: OSErr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  246.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  247.     INLINE $303C, $1704, $A82F;
  248.     {$ENDC}
  249. FUNCTION DBGetSessionNum(sessID: LONGINT; VAR sessNum: INTEGER; asyncPB: DBAsyncParmBlkPtr): OSErr;
  250.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  251.     INLINE $303C, $0605, $A82F;
  252.     {$ENDC}
  253. FUNCTION DBSend(sessID: LONGINT; text: Ptr; len: INTEGER; asyncPB: DBAsyncParmBlkPtr): OSErr;
  254.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  255.     INLINE $303C, $0706, $A82F;
  256.     {$ENDC}
  257. FUNCTION DBSendItem(sessID: LONGINT; dataType: DBType; len: INTEGER; places: INTEGER; flags: INTEGER; buffer: UNIV Ptr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  258.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  259.     INLINE $303C, $0B07, $A82F;
  260.     {$ENDC}
  261. FUNCTION DBExec(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  262.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  263.     INLINE $303C, $0408, $A82F;
  264.     {$ENDC}
  265. FUNCTION DBState(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  266.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  267.     INLINE $303C, $0409, $A82F;
  268.     {$ENDC}
  269. FUNCTION DBGetErr(sessID: LONGINT; VAR err1: LONGINT; VAR err2: LONGINT; VAR item1: Str255; VAR item2: Str255; VAR errorMsg: Str255; asyncPB: DBAsyncParmBlkPtr): OSErr;
  270.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  271.     INLINE $303C, $0E0A, $A82F;
  272.     {$ENDC}
  273. FUNCTION DBBreak(sessID: LONGINT; abort: BOOLEAN; asyncPB: DBAsyncParmBlkPtr): OSErr;
  274.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  275.     INLINE $303C, $050B, $A82F;
  276.     {$ENDC}
  277. FUNCTION DBGetItem(sessID: LONGINT; timeout: LONGINT; VAR dataType: DBType; VAR len: INTEGER; VAR places: INTEGER; VAR flags: INTEGER; buffer: UNIV Ptr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  278.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  279.     INLINE $303C, $100C, $A82F;
  280.     {$ENDC}
  281. FUNCTION DBUnGetItem(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  282.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  283.     INLINE $303C, $040D, $A82F;
  284.     {$ENDC}
  285. FUNCTION DBKill(asyncPB: DBAsyncParmBlkPtr): OSErr;
  286.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  287.     INLINE $303C, $020E, $A82F;
  288.     {$ENDC}
  289. FUNCTION DBGetNewQuery(queryID: INTEGER; VAR query: QueryHandle): OSErr;
  290.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  291.     INLINE $303C, $030F, $A82F;
  292.     {$ENDC}
  293. FUNCTION DBDisposeQuery(query: QueryHandle): OSErr;
  294.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  295.     INLINE $303C, $0210, $A82F;
  296.     {$ENDC}
  297. FUNCTION DBStartQuery(VAR sessID: LONGINT; query: QueryHandle; statusProc: DBStatusUPP; asyncPB: DBAsyncParmBlkPtr): OSErr;
  298.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  299.     INLINE $303C, $0811, $A82F;
  300.     {$ENDC}
  301. FUNCTION DBGetQueryResults(sessID: LONGINT; VAR results: ResultsRecord; timeout: LONGINT; statusProc: DBStatusUPP; asyncPB: DBAsyncParmBlkPtr): OSErr;
  302.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  303.     INLINE $303C, $0A12, $A82F;
  304.     {$ENDC}
  305. FUNCTION DBResultsToText(VAR results: ResultsRecord; VAR theText: Handle): OSErr;
  306.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  307.     INLINE $303C, $0413, $A82F;
  308.     {$ENDC}
  309. FUNCTION DBInstallResultHandler(dataType: DBType; theHandler: DBResultHandlerUPP; isSysHandler: BOOLEAN): OSErr;
  310.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  311.     INLINE $303C, $0514, $A82F;
  312.     {$ENDC}
  313. FUNCTION DBRemoveResultHandler(dataType: DBType): OSErr;
  314.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  315.     INLINE $303C, $0215, $A82F;
  316.     {$ENDC}
  317. FUNCTION DBGetResultHandler(dataType: DBType; VAR theHandler: DBResultHandlerUPP; getSysHandler: BOOLEAN): OSErr;
  318.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  319.     INLINE $303C, $0516, $A82F;
  320.     {$ENDC}
  321. FUNCTION DBIdle: OSErr;
  322.     {$IFC TARGET_OS_MAC AND TARGET_CPU_68K AND NOT TARGET_RT_MAC_CFM}
  323.     INLINE $303C, $00FF, $A82F;
  324.     {$ENDC}
  325.  
  326.  
  327. {$ALIGN RESET}
  328. {$POP}
  329.  
  330. {$SETC UsingIncludes := DatabaseAccessIncludes}
  331.  
  332. {$ENDC} {__DATABASEACCESS__}
  333.  
  334. {$IFC NOT UsingIncludes}
  335.  END.
  336. {$ENDC}
  337.